<html lang="en-US">

<head>
    
<title>简单围观一下有趣的 //go: 指令 - 花落雨忧</title>

<meta property="og:title" content="简单围观一下有趣的 //go: 指令 - 花落雨忧">



    



    
    <meta property="description" content="[&amp;hellip;] 如果你平时有翻看源码的习惯，你肯定会发现。咦，怎么有的方法上面总是写着 //go: 这类指令呢。他们到底是干嘛用的？
今天我们一同揭开他们的面纱，我将简单给你介绍一下，它们都负责些什么
[&amp;hellip;] //go:linkname localname importpath.name 该指令指示编译器使用 importpath.name &amp;hellip;">
    <meta property="og:description" content="[&amp;hellip;] 如果你平时有翻看源码的习惯，你肯定会发现。咦，怎么有的方法上面总是写着 //go: 这类指令呢。他们到底是干嘛用的？
今天我们一同揭开他们的面纱，我将简单给你介绍一下，它们都负责些什么
[&amp;hellip;] //go:linkname localname importpath.name 该指令指示编译器使用 importpath.name &amp;hellip;">
    






<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1">

<link rel="shortcut icon" href="https://www.lican.site/logo/logo.png" type="image/x-icon" />



<link rel="stylesheet" href="/css/style.min.css" />

<link rel="stylesheet" href="/css/reset.min.css" />




<script src="https://www.lican.site/js/highlight.min.js"></script>

<script>
hljs.configure({ ignoreUnescapedHTML: true })
hljs.highlightAll();
</script>


<script src="https://www.lican.site/js/jquery.min.js"></script>




<link href="https://www.lican.site/css/hugo-code.min.css" rel="stylesheet" />



    <style>
        .post-content img {
            max-width: 400px;
        }
    </style>
</head>

<body id="period" class="home blog">
    <a class="skip-content" href="#main">Press "Enter" to skip to content</a>
    <div id="overflow-container" class="overflow-container">
        <header class="site-header" id="site-header" role="banner">
    <div class="max-width">
        <div id="title-container" class="title-container">
            <div id="site-title" class="site-title"><a href="/">花落雨忧</a></div>
            <p class="tagline">思所及 力所行 方为真.</p>
        </div>
        
        <div id="menu-primary-container" class="menu-primary-container">
            <div class="icon-container">
            </div>
            <div id="menu-primary" class="menu-container menu-primary" role="navigation">
                <nav class="menu">
                    <ul id="menu-primary-items" class="menu-primary-items">
                        
                        
                        <li id="menu-item-0"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/posts" aria-current="page" tabindex="0">首页</a></li>
                        
                        <li id="menu-item-1"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/tech/" aria-current="page" tabindex="1">技术文档</a></li>
                        
                        <li id="menu-item-2"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/article/" aria-current="page" tabindex="2">文章</a></li>
                        
                        <li id="menu-item-3"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/project/" aria-current="page" tabindex="3">项目</a></li>
                        
                        <li id="menu-item-4"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/about/" aria-current="page" tabindex="4">关于</a></li>
                        
                    </ul>
                </nav>
            </div>
        </div>
    </div>
</header>
        <div id="primary-container" class="primary-container">
            <div class="max-width">
                <section id="main" class="main" role="main">
                    <div id="loop-container" class="loop-container">
                        <div
                            class="post type-post status-publish format-standard hentry entry">
                            <article>
                                <div class="post-container">
                                    <div class="post-header">
                                        <h2 class="post-title">
                                            <a href="/posts/go/talk/2019-03-31-go-ins/">简单围观一下有趣的 //go: 指令</a>
                                        </h2>
                                        
                                        <div class="post-byline">Published on
                                            <a class="date" href="javascript:;">2019/03/31</a>
                                            
                                            
                                            
                                            By 
                                            <a class="author" href="javascript:;">煎鱼</a></div>
                                            
                                        
                                    </div>
                                    <div class="post-content">
                                        <p><img src="http://wx2.sinaimg.cn/large/006fVPCvly1g1m1bplu3mj30xc0m8myg.jpg" alt="image"></p>
<h2 id="前言">前言</h2>
<p>如果你平时有翻看源码的习惯，你肯定会发现。咦，怎么有的方法上面总是写着 <code>//go:</code>  这类指令呢。他们到底是干嘛用的？</p>
<p>今天我们一同揭开他们的面纱，我将简单给你介绍一下，它们都负责些什么</p>
<h2 id="golinkname">go:linkname</h2>
<pre><code>//go:linkname localname importpath.name
</code></pre><p>该指令指示编译器使用 <code>importpath.name</code> 作为源代码中声明为 <code>localname</code> 的变量或函数的目标文件符号名称。但是由于这个伪指令，可以破坏类型系统和包模块化。因此只有引用了 unsafe 包才可以使用</p>
<p>简单来讲，就是 <code>importpath.name</code> 是 <code>localname</code> 的符号别名，编译器实际上会调用 <code>localname</code> 。但前提是使用了 <code>unsafe</code> 包才能使用</p>
<h3 id="案例">案例</h3>
<h4 id="timetimego">time/time.go</h4>
<pre><code>...
func now() (sec int64, nsec int32, mono int64)
</code></pre><h4 id="runtimetimestubgo">runtime/timestub.go</h4>
<pre><code>import _ &quot;unsafe&quot; // for go:linkname

//go:linkname time_now time.now
func time_now() (sec int64, nsec int32, mono int64) {
	sec, nsec = walltime()
	return sec, nsec, nanotime() - startNano
}
</code></pre><p>在这个案例中可以看到 <code>time.now</code>，它并没有具体的实现。如果你初看可能会懵逼。这时候建议你全局搜索一下源码，你就会发现其实现在 <code>runtime.time_now</code> 中</p>
<p>配合先前的用法解释，可得知在 runtime 包中，我们声明了 <code>time_now</code> 方法是 <code>time.now</code> 的符号别名。并且在文件头引入了 <code>unsafe</code> 达成前提条件</p>
<h2 id="gonoescape">go:noescape</h2>
<pre><code>//go:noescape
</code></pre><p>该指令指定下一个有声明但没有主体（意味着实现有可能不是 Go）的函数，不允许编译器对其做逃逸分析</p>
<p>一般情况下，该指令用于内存分配优化。因为编译器默认会进行逃逸分析，会通过规则判定一个变量是分配到堆上还是栈上。但凡事有意外，一些函数虽然逃逸分析其是存放到堆上。但是对于我们来说，它是特别的。我们就可以使用 <code>go:noescape</code> 指令强制要求编译器将其分配到函数栈上</p>
<h3 id="案例-1">案例</h3>
<pre><code>// memmove copies n bytes from &quot;from&quot; to &quot;to&quot;.
// in memmove_*.s
//go:noescape
func memmove(to, from unsafe.Pointer, n uintptr)
</code></pre><p>我们观察一下这个案例，它满足了该指令的常见特性。如下：</p>
<ul>
<li>memmove_*.s：只有声明，没有主体。其主体是由底层汇编实现的</li>
<li>memmove：函数功能，在栈上处理性能会更好</li>
</ul>
<h2 id="gonosplit">go:nosplit</h2>
<pre><code>//go:nosplit
</code></pre><p>该指令指定文件中声明的下一个函数不得包含堆栈溢出检查。简单来讲，就是这个函数跳过堆栈溢出的检查</p>
<h3 id="案例-2">案例</h3>
<pre><code>//go:nosplit
func key32(p *uintptr) *uint32 {
	return (*uint32)(unsafe.Pointer(p))
}
</code></pre><h2 id="gonowritebarrierrec">go:nowritebarrierrec</h2>
<pre><code>//go:nowritebarrierrec
</code></pre><p>该指令表示编译器遇到写屏障时就会产生一个错误，并且允许递归。也就是这个函数调用的其他函数如果有写屏障也会报错。简单来讲，就是针对写屏障的处理，防止其死循环</p>
<h3 id="案例-3">案例</h3>
<pre><code>//go:nowritebarrierrec
func gcFlushBgCredit(scanWork int64) {
    ...
}
</code></pre><h2 id="goyeswritebarrierrec">go:yeswritebarrierrec</h2>
<pre><code>//go:yeswritebarrierrec
</code></pre><p>该指令与 <code>go:nowritebarrierrec</code> 相对，在标注 <code>go:nowritebarrierrec</code> 指令的函数上，遇到写屏障会产生错误。而当编译器遇到 <code>go:yeswritebarrierrec</code> 指令时将会停止</p>
<h3 id="案例-4">案例</h3>
<pre><code>//go:yeswritebarrierrec
func gchelper() {
	...
}
</code></pre><h2 id="gonoinline">go:noinline</h2>
<p>该指令表示该函数禁止进行内联</p>
<h3 id="案例-5">案例</h3>
<pre><code>//go:noinline
func unexportedPanicForTesting(b []byte, i int) byte {
	return b[i]
}
</code></pre><p>我们观察一下这个案例，是直接通过索引取值，逻辑比较简单。如果不加上 <code>go:noinline</code> 的话，就会出现编译器对其进行内联优化</p>
<p>显然，内联有好有坏。该指令就是提供这一特殊处理</p>
<h2 id="gonorace">go:norace</h2>
<pre><code>//go:norace
</code></pre><p>该指令表示禁止进行竞态检测。而另外一种常见的形式就是在启动时执行 <code>go run -race</code>，能够检测应用程序中是否存在双向的数据竞争。非常有用</p>
<h3 id="案例-6">案例</h3>
<pre><code>//go:norace
func forkAndExecInChild(argv0 *byte, argv, envv []*byte, chroot, dir *byte, attr *ProcAttr, sys *SysProcAttr, pipe int) (pid int, err Errno) {
    ...
}
</code></pre><h2 id="gonotinheap">go:notinheap</h2>
<pre><code>//go:notinheap
</code></pre><p>该指令常用于类型声明，它表示这个类型不允许从 GC 堆上进行申请内存。在运行时中常用其来做较低层次的内部结构，避免调度器和内存分配中的写屏障。能够提高性能</p>
<h3 id="案例-7">案例</h3>
<pre><code>// notInHeap is off-heap memory allocated by a lower-level allocator
// like sysAlloc or persistentAlloc.
//
// In general, it's better to use real types marked as go:notinheap,
// but this serves as a generic type for situations where that isn't
// possible (like in the allocators).
//
//go:notinheap
type notInHeap struct{}
</code></pre><h2 id="总结">总结</h2>
<p>在本文我们简单介绍了一些常见的指令集，我建议仅供了解。一般我们是用不到的，因为你的瓶颈可能更多的在自身应用上</p>
<p>但是了解这一些，对你了解底层源码和运行机制会更有帮助。如果想再深入些，可阅读我给出的参考链接 ：）</p>
<h2 id="参考">参考</h2>
<ul>
<li><a href="https://github.com/golang/go/blob/master/src/runtime/HACKING.md">HACKING</a></li>
<li><a href="https://golang.org/cmd/compile/">Command compile</a></li>
</ul>


                                        
                                        
                                        
                                        <div class="rp4wp-related-posts">
                                            <h3>相关文章</h3>
                                            <ul>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/map/2019-03-24-map-assign/">深入理解 Go map：赋值和扩容迁移</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/map/2019-03-05-map-access/">深入理解 Go map：初始化和访问元素</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/talk/2019-02-17-for-loop-json-unmarshal/">for-loop 与 json.Unmarshal 性能分析概要</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/talk/2019-01-20-control-goroutine/">来，控制一下 goroutine 的并发数量</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/slice/2019-01-06-why-slice-max/">Go Slice 最大容量大小是怎么来的</a>
                                                    </div>
                                                </li>
                                                
                                            </ul>
                                        </div>
                                        
                                        
                                    </div>

                                    
                                    
                                    

                                    
                                    <div class="post-meta">
                                        
                                        
                                        <div class="post-tags">
                                            <ul>
                                            
                                            <li>
                                                <a href="/tags/go" title="View all posts tagged match">go</a>
                                            </li>
                                            
                                            </ul>
                                        </div>
                                        
                                        
                                        <nav class="further-reading">
                                            
                                            <div class="previous">
                                                <span>&lt;&lt; Prev</span>
                                                <a href="https://www.lican.site/posts/go/map/2019-03-24-map-assign/"
                                                    rel="prev">深入理解 Go map：赋值和扩容迁移</a> </div>
                                            
                                            
                                            <div class="next">
                                                <span>Next >></span>
                                                <a href="https://www.lican.site/posts/go/map/2019-04-07-why-map-no-order/">为什么遍历 Go map 是无序的</a> 
                                            </div>
                                            
                                        </nav>
                                    </div>
                                    
                                    

                                    
                                    
                                    

                                </div>
                            </article>
                        </div>
                    </div>
                </section>
                <aside class="sidebar sidebar-primary" id="sidebar-primary" role="complementary">
    <h1 class="screen-reader-text">Sidebar</h1>
    

    
    
    <section id="text-2" class="widget widget_text">
        <div class="textwidget">
            
            <div id="profile">
                <div id="profile_picture"><img src="https://www.lican.site/logo/logo.png"></div>
                <div id="profile_intro">
                    <p><span class="name">Lican</span></p>
                    <p class="intro">全栈开发者，爱好造轮子。</p>
                </div>
            </div>
            
            <p>
                <script type="text/javascript">
                    (function ($) {
                        $(document).ready(function () {
                            var menuPrimaryContainer = $('#menu-primary-container');
                            var profile = $('#text-2');
                            $('#toggle-navigation').click(function () {
                                if (menuPrimaryContainer.hasClass('open')) {
                                    profile.removeClass('open');
                                } else {
                                    profile.addClass('open');
                                }
                            });
                        });
                    })(jQuery);
                </script>
            </p>
        </div>
    </section>
    
    
    
    
    
    <section id="text-5" class="widget widget_text">
        <h2 class="widget-title">开源项目</h2>
        <div class="textwidget">
            <div id="projects" style="line-height: 22px;">
                
                <a href="https://github.com/idoubi/gonews"
                    target="_blank">gonews</a>: &nbsp;Daily news for golang<br>
                
                <a href="https://github.com/idoubi/sql2struct"
                    target="_blank">sql2struct</a>: &nbsp;Generate go struct according to SQL<br>
                
                <a href="https://github.com/idoubi/goz"
                    target="_blank">goz</a>: &nbsp;Request library used in golang<br>
                
        </div>
    </section>
    
    

    
    
    
    
    

    
    
    

    
    
    

    
    
    
    
</aside>
            </div>
        </div>

        <footer id="site-footer" class="site-footer" role="contentinfo">
    <div class="max-width">
    </div>
    <div class="footer">
        <div id="footercontent">
            © lican.vip All rights reserved<br/>
            Built with Hugo Theme <a href="https://github.com/idoubi/hugo-theme-period" target="_blank">Period</a>
        </div>
    </div>
</footer>

<script>
    var _hmt = _hmt || [];
    (function() {
      var hm = document.createElement("script");
      hm.src = "https://hm.baidu.com/hm.js?e8351b6d4626d5881d439ea1f6184baa";
      var s = document.getElementsByTagName("script")[0]; 
      s.parentNode.insertBefore(hm, s);
    })();
</script>
    
    
    </div>
    
</body>

</html>